Skip to main content

@pexip/vpaas-api

Enumerations​

Classes​

Interfaces​

Type Aliases​

BadRequest​

Ƭ BadRequest: types.components["responses"][``"BadRequest"``]["content"][``"application/json"``]

Codec​

Ƭ Codec: "h264" | "vp8" | "vp9" | "opus" | "rtx"

This interface was referenced by VpaasWebsocketMessageTypes's JSON-Schema via the definition "Codec".

ErrorType​

Ƭ ErrorType: "authentication_failed" | "unsupported_message" | "invalid_json" | "invalid_message" | "sdp_offer_processing" | "sdp_offer_update_processing" | "server_error" | "invalid_parameter" | "resource_unavailable"

This interface was referenced by VpaasWebsocketMessageTypes's JSON-Schema via the definition "ErrorType".

Forbidden​

Ƭ Forbidden: types.components["responses"][``"Forbidden"``]["content"][``"application/json"``]

Gone​

Ƭ Gone: types.components["responses"][``"Gone"``]["content"][``"application/json"``]

JoinMeeting​

Ƭ JoinMeeting: types.components["schemas"][``"JoinDetails"``]

MediaSemantic​

Ƭ MediaSemantic: "main" | "presentation" | "misc"

This interface was referenced by VpaasWebsocketMessageTypes's JSON-Schema via the definition "MediaSemantic".

MediaStream​

Ƭ MediaStream: VideoStream | AudioStream

This interface was referenced by undefined's JSON-Schema definition via the patternProperty ".*".

This interface was referenced by VpaasWebsocketMessageTypes's JSON-Schema via the definition "MediaStream".

Meeting​

Ƭ Meeting: types.components["schemas"][``"Meeting"``]

NotFound​

Ƭ NotFound: types.components["responses"][``"NotFound"``]["content"][``"application/json"``]

Participant​

Ƭ Participant: types.components["schemas"][``"ParticipantWithSecret"``]

ParticipantID​

Ƭ ParticipantID: string

This interface was referenced by VpaasWebsocketMessageTypes's JSON-Schema via the definition "ParticipantID".

ServiceUnavailable​

Ƭ ServiceUnavailable: types.components["responses"][``"ServiceUnavailable"``]["content"][``"application/json"``]

Token​

Ƭ Token: types.components["schemas"][``"AccessToken"``]

Unauthorized​

Ƭ Unauthorized: types.components["responses"][``"Unauthorized"``]["content"][``"application/json"``]

VpaasWebsocketMessageTypesUnion​

Ƭ VpaasWebsocketMessageTypesUnion: ServerError & { id?: string ; ref?: string ; trace?: { traceparent?: string ; tracestate?: string } ; type: "server_error" } | Error & { id?: string ; ref?: string ; trace?: { traceparent?: string ; tracestate?: string } ; type: "error" } | Ping & { id?: string ; ref?: string ; trace?: { traceparent?: string ; tracestate?: string } ; type: "ping" } | Pong & { id?: string ; ref?: string ; trace?: { traceparent?: string ; tracestate?: string } ; type: "pong" } | Success & { id?: string ; ref?: string ; trace?: { traceparent?: string ; tracestate?: string } ; type: "success" } | Auth & { id?: string ; ref?: string ; trace?: { traceparent?: string ; tracestate?: string } ; type: "authenticate" } | MediaOffer & { id?: string ; ref?: string ; trace?: { traceparent?: string ; tracestate?: string } ; type: "media_offer" } | AddNewCandidate & { id?: string ; ref?: string ; trace?: { traceparent?: string ; tracestate?: string } ; type: "add_new_candidate" } | RosterUpdate & { id?: string ; ref?: string ; trace?: { traceparent?: string ; tracestate?: string } ; type: "roster_update" } | RequestStream & { id?: string ; ref?: string ; trace?: { traceparent?: string ; tracestate?: string } ; type: "request_stream" } | RequestStreamResponse & { id?: string ; ref?: string ; trace?: { traceparent?: string ; tracestate?: string } ; type: "request_stream_response" } | DisconnectStream & { id?: string ; ref?: string ; trace?: { traceparent?: string ; tracestate?: string } ; type: "disconnect_stream" }

This interface was referenced by VpaasWebsocketMessageTypes's JSON-Schema via the definition "VpaasWebsocketMessageTypesUnion".

Functions​

createApi​

▸ createApi(): Api

Creates MEE api wrapper for the given apiAddress and token

Returns​

Api

Api wrapper with all the main CRUD fns

setLogger​

▸ setLogger(newLogger): void

Parameters​

NameType
newLoggerLogger

Returns​

void

withToken​

▸ withToken(createAndSignJWT, apiAddress): (api: Api) => { create: (__namedParameters: { headers?: HeadersInit }) => Promise<Status<{ created_at?: string ; id: string ; status?: "unknown" | "ready" | "running" | "ended" ; updated_at?: string }>> ; participants: (__namedParameters: { headers?: HeadersInit ; meetingId: string }) => Promise<Status<{ created_at: string ; id: string ; meeting_id: string ; participant_secret: string ; status: "ready" | "joined" | "left" | "removed" ; updated_at: string }>> }

Parameters​

NameType
createAndSignJWT() => string
apiAddressstring

Returns​

fn

▸ (api): Object

Parameters​
NameType
apiApi
Returns​

Object

NameType
create(__namedParameters: { headers?: HeadersInit }) => Promise<Status<{ created_at?: string ; id: string ; status?: "unknown" | "ready" | "running" | "ended" ; updated_at?: string }>>
participants(__namedParameters: { headers?: HeadersInit ; meetingId: string }) => Promise<Status<{ created_at: string ; id: string ; meeting_id: string ; participant_secret: string ; status: "ready" | "joined" | "left" | "removed" ; updated_at: string }>>